filter-object

filter-object

Filter an object by its keys or values. Returns a copy of an object filtered to have only keys or values that match the given glob patterns.

Install

Install with npm

$ npm i filter-object --save

Usage

Filter with glob patterns

var filter = require('filter-object');

filter({a: 'a', b: 'b', c: 'c'}, '*');
//=> {a: 'a', b: 'b', c: 'c'}

filter({a: 'a', b: 'b', c: 'c'}, 'b');
//=> {b: 'b'}

filter({foo: 'a', bar: 'b', baz: 'c'}, 'b*');
//=> {bar: 'b', baz: 'c'}

filter({a: 'a', b: 'b', c: 'c'}, '{b,c}');
//=> {b: 'b', c: 'c'}

Negation patterns work as well:

filter({foo: 'a', bar: 'b', baz: 'c'}, ['*', '!b*']);
//=> {foo: 'a'}

options

Pass options to sort-object and/or filter-keys

filter({foo: 'a', bar: 'b', baz: 'c'}, ['*', '!b*'], options);

See sort-object for the full range of options and features.

Filter with a callback function

filter({a: 'a', b: 'b', c: 'c'}, function(val) {
  return val !== 'b';
});
//=> {a: 'a', c: 'c'}

Related

• filter-keys: Filter the keys of an object using glob patterns. | homepage
• filter-values: Filter an object values using glob patterns or with a callback function returns true. | homepage
• micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… more | homepage
• rename-keys: Modify the names of the own enumerable properties (keys) of an object. | homepage
• sort-object: Sort the keys in an object. | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on September 08, 2015.